Crate async_priority_channel
source ·Expand description
An async channel where pending messages are delivered in order of priority.
There are two kinds of channels:
A channel has the Sender
and Receiver
side. Both sides are cloneable and can be shared
among multiple threads. When sending, you pass in a message and its
priority. When receiving, you’ll get back the pending message with the
highest priotiy.
When all Sender
s or all Receiver
s are dropped, the channel becomes closed. When a
channel is closed, no more messages can be sent, but remaining messages can still be received.
The channel can also be closed manually by calling Sender::close()
or
Receiver::close()
. The API and much of the documentation is based on async_channel.
Examples
let (s, r) = async_priority_channel::unbounded();
assert_eq!(s.send("Foo", 0).await, Ok(()));
assert_eq!(s.send("Bar", 2).await, Ok(()));
assert_eq!(s.send("Baz", 1).await, Ok(()));
assert_eq!(r.recv().await, Ok(("Bar", 2)));
Structs
- Receive side of the channel. Can be cloned.
- An error returned from
Receiver::recv()
. - An error returned from
Sender::send()
. - Send side of the channel. Can be cloned.
Enums
- An error returned from
Receiver::try_recv()
. - An error returned from
Sender::try_send()
.
Functions
- Creates a bounded channel.
- Creates an unbounded channel.